Skip to content

Python script to generate man page #1392

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 11 commits into from
Nov 13, 2024
Merged

Python script to generate man page #1392

merged 11 commits into from
Nov 13, 2024

Conversation

@Tiuxi
Copy link
Contributor

@Tiuxi Tiuxi commented Nov 12, 2024

Added the script scripts/gen-man.py that generate a man page using the src/data/help.json file, and print the generated file to stdout.

close #830

@CarterLi
Copy link
Member 

scripts/gen-man.py:146: SyntaxWarning: invalid escape sequence '\-'
  print(f"\-{ option['short'] }", end="")
scripts/gen-man.py:153: SyntaxWarning: invalid escape sequence '\-'
  print(f"\-\-{ option['long'] }", end="")

@CarterLi
Copy link
Member

I'd like to keep the Config Files section in the old man file.

@CarterLi
Copy link
Member

CarterLi commented Nov 12, 2024 •
edited
Loading

You can acquire the fastfetch version from CMakeList.txt using RegExp ^\s*VERSION (\d+\.\d+\.\d+)$

@Tiuxi
Copy link
Contributor Author

Tiuxi commented Nov 12, 2024

Is it relevant to also put a short example of a config file (E.g from a preset) at the end ?

@CarterLi
Copy link
Member

Yes. You should also metion the Github Wiki page.

@Tiuxi Tiuxi marked this pull request as draft November 12, 2024 04:50
@Tiuxi Tiuxi marked this pull request as ready for review November 12, 2024 04:50
@CarterLi CarterLi mentioned this pull request Nov 12, 2024
Closed
@CarterLi CarterLi merged commit bccf241 into fastfetch-cli:dev Nov 13, 2024
16 checks passed
@Dariqq
Copy link
Contributor

Dariqq commented Nov 13, 2024

Hi, would it be possible to have the timestamp respect SOURCE_DATE_EPOCH ? See https://reproducible-builds.org/docs/source-date-epoch/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[FEAT] More documentation in the Manpage

3 participants

@Tiuxi @CarterLi @Dariqq